<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
  <head>
    <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
    <title>timeinstk</title>
    <link rel="stylesheet" type="text/css" href="csound.css" />
    <meta name="generator" content="DocBook XSL Stylesheets V1.78.1" />
    <link rel="home" href="index.html" title="The Canonical Csound Reference Manual" />
    <link rel="up" href="OpcodesTop.html" title="Orchestra Opcodes and Operators" />
    <link rel="prev" href="timedseq.html" title="timedseq" />
    <link rel="next" href="timeinsts.html" title="timeinsts" />
  </head>
  <body>
    <div class="navheader">
      <table width="100%" summary="Navigation header">
        <tr>
          <th colspan="3" align="center">timeinstk</th>
        </tr>
        <tr>
          <td width="20%" align="left"><a accesskey="p" href="timedseq.html">Prev</a> </td>
          <th width="60%" align="center">Orchestra Opcodes and Operators</th>
          <td width="20%" align="right"> <a accesskey="n" href="timeinsts.html">Next</a></td>
        </tr>
      </table>
      <hr />
    </div>
    <div class="refentry">
      <a id="timeinstk"></a>
      <div class="titlepage"></div>
      <a id="IndexTimeinstk" class="indexterm"></a>
      <div class="refnamediv">
        <h2>
          <span class="refentrytitle">timeinstk</span>
        </h2>
        <p>timeinstk — 
      Read absolute time in k-rate cycles.
    </p>
      </div>
      <div class="refsect1">
        <a id="idp158367360"></a>
        <h2>Description</h2>
        <p>
    	Read absolute time, in k-rate cycles, since the start of an
    	instance of an instrument. Called at both i-time as well as
    	k-time.
    </p>
      </div>
      <div class="refsect1">
        <a id="idp158368672"></a>
        <h2>Syntax</h2>
        <pre class="synopsis">kres <span class="command"><strong>timeinstk</strong></span></pre>
      </div>
      <div class="refsect1">
        <a id="idp158370656"></a>
        <h2>Performance</h2>
        <p>
      <span class="emphasis"><em>timeinstk</em></span> is for time in k-rate cycles. So with:

      </p>
        <div class="informalexample">
          <pre class="programlisting">
  <span class="opc">sr</span>    <span class="op">=</span> 44100
  <span class="opc">kr</span>    <span class="op">=</span> 6300
  <span class="opc">ksmps</span> <span class="op">=</span> 7</pre>
        </div>
        <p>

      then after half a second, the <span class="emphasis"><em>timeinstk</em></span> opcode would report 3150. It will always report an integer.
    </p>
        <p>
      <span class="emphasis"><em>timeinstk</em></span> produces a k-rate variable for output. There are no input parameters.
    </p>
        <p>
      <span class="emphasis"><em>timeinstk</em></span> is similar to <a class="link" href="timek.html" title="timek"><em class="citetitle">timek</em></a> except it returns the time since the start of this instance of the instrument.
    </p>
      </div>
      <div class="refsect1">
        <a id="idp158380480"></a>
        <h2>Examples</h2>
        <p>
      Here is an example of the timeinstk opcode. It uses the file <a class="ulink" href="examples/timeinstk.csd" target="_top"><em class="citetitle">timeinstk.csd</em></a>.

      </p>
        <div class="example">
          <a id="idp158382336"></a>
          <p class="title">
            <strong>Example 927. Example of the timeinstk opcode.</strong>
          </p>
          <div class="example-contents">
            <p>See the sections <a class="link" href="UsingRealTime.html" title="Real-Time Audio"><em class="citetitle">Real-time Audio</em></a> and <a class="link" href="CommandFlags.html" title="Csound command line"><em class="citetitle">Command Line Flags</em></a> for more information on using command line flags.</p>
            <pre class="programlisting">
<span class="csdtag">&lt;CsoundSynthesizer&gt;</span>
<span class="csdtag">&lt;CsOptions&gt;</span>
<span class="comment">; Select audio/midi flags here according to platform</span>
<span class="comment">; Audio out   Audio in</span>
-odac           -iadc    <span class="comment">;;;RT audio I/O</span>
<span class="comment">; For Non-realtime ouput leave only the line below:</span>
<span class="comment">; -o timeinstk.wav -W ;;; for file output any platform</span>
<span class="csdtag">&lt;/CsOptions&gt;</span>
<span class="csdtag">&lt;CsInstruments&gt;</span>

<span class="comment">; Initialize the global variables.</span>
<span class="ohdr">sr</span> <span class="op">=</span> 44100
<span class="ohdr">kr</span> <span class="op">=</span> 4410
<span class="ohdr">ksmps</span> <span class="op">=</span> 10
<span class="ohdr">nchnls</span> <span class="op">=</span> 1

<span class="comment">; Instrument #1.</span>
<span class="oblock">instr</span> 1
  <span class="comment">; Print out the value from timeinstk every half-second.</span>
  k1 <span class="opc">timeinstk</span>
  <span class="opc">printks</span> "k1 <span class="op">=</span> <span class="op">%</span>f samples\\n", 0.5, k1
<span class="oblock">endin</span>


<span class="csdtag">&lt;/CsInstruments&gt;</span>
<span class="csdtag">&lt;CsScore&gt;</span>

<span class="comment">; Play Instrument #1 for two seconds.</span>
<span class="stamnt">i</span> 1 0 2
<span class="stamnt">e</span>


<span class="csdtag">&lt;/CsScore&gt;</span>
<span class="csdtag">&lt;/CsoundSynthesizer&gt;</span>
</pre>
          </div>
        </div>
        <p><br class="example-break" />

      Its output should include lines like this:
      </p>
        <pre class="screen">
k1 = 1.000000 samples
k1 = 2205.000000 samples
k1 = 4410.000000 samples
k1 = 6615.000000 samples
k1 = 8820.000000 samples
      </pre>
        <p>
    </p>
      </div>
      <div class="refsect1">
        <a id="idp158387472"></a>
        <h2>See Also</h2>
        <p>
      <a class="link" href="timeinsts.html" title="timeinsts"><em class="citetitle">timeinsts</em></a>, <a class="link" href="timek.html" title="timek"><em class="citetitle">timek</em></a>, <a class="link" href="times.html" title="times"><em class="citetitle">times</em></a>
    </p>
      </div>
      <div class="refsect1">
        <a id="idp158391408"></a>
        <h2>Credits</h2>
        <p>
      </p>
        <table border="0" summary="Simple list" class="simplelist">
          <tr>
            <td>Author: Robin Whittle</td>
          </tr>
          <tr>
            <td>Australia</td>
          </tr>
          <tr>
            <td>May 1997</td>
          </tr>
        </table>
        <p>
    </p>
        <p>Example written by Kevin Conder.</p>
      </div>
    </div>
    <div class="navfooter">
      <hr />
      <table width="100%" summary="Navigation footer">
        <tr>
          <td width="40%" align="left"><a accesskey="p" href="timedseq.html">Prev</a> </td>
          <td width="20%" align="center">
            <a accesskey="u" href="OpcodesTop.html">Up</a>
          </td>
          <td width="40%" align="right"> <a accesskey="n" href="timeinsts.html">Next</a></td>
        </tr>
        <tr>
          <td width="40%" align="left" valign="top">timedseq </td>
          <td width="20%" align="center">
            <a accesskey="h" href="index.html">Home</a>
          </td>
          <td width="40%" align="right" valign="top"> timeinsts</td>
        </tr>
      </table>
    </div>
  </body>
</html>
